Skip to content

README: swap monthly downloads badge for cumulative; drop docs-passing badge#395

Merged
igerber merged 1 commit intomainfrom
docs/readme-badge-cumulative-downloads
Apr 26, 2026
Merged

README: swap monthly downloads badge for cumulative; drop docs-passing badge#395
igerber merged 1 commit intomainfrom
docs/readme-badge-cumulative-downloads

Conversation

@igerber
Copy link
Copy Markdown
Owner

@igerber igerber commented Apr 26, 2026

Summary

  • Replace `shields.io/pypi/dm` (downloads-per-month) with `pepy.tech` cumulative downloads badge
  • Drop the readthedocs build-status badge — it acts as a clickable nav link but conveys no real information; the README has Documentation links elsewhere

Why

  • Cumulative > monthly for trust signaling: a growing cumulative anchors confidence and never dips on a slow month, which matters more for first-time visitor RTB than "is this alive today" signaling
  • RTD build-status badge is theater: RTD builds basically always pass, the green badge says nothing about whether docs are accurate or current, and removing it frees a slot above the fold

Methodology references

  • N/A — README presentation change only

Validation

  • Visual check on local file; no test changes
  • Badge URL pattern `https://static.pepy.tech/badge/diff-diff\` is the documented pepy badge endpoint and resolves to the same project as the docs page already linked

Security / privacy

  • Confirm no secrets/PII in this PR: Yes

…g badge

- Replace shields.io/pypi/dm (downloads-per-month) with pepy.tech cumulative
  badge — better as a trust / reason-to-believe signal that doesn't dip on
  slow months.
- Drop the readthedocs build-status badge — it acts as a clickable nav link
  but says nothing meaningful about doc quality, and the README already
  carries Documentation links elsewhere.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

Overall Assessment

✅ Looks good

Executive Summary

  • Scope is limited to the README badge strip: the PR swaps the downloads badge source and removes the Read the Docs build-status badge in README.md:L9-L13.
  • No estimator, variance/SE logic, weighting, identification assumption, default behavior, or API surface is touched; methodology review is therefore non-applicable beyond confirming no affected registry entry in docs/methodology/REGISTRY.md.
  • Documentation discoverability remains intact because the README still contains a dedicated documentation section with direct links in README.md:L49-L56.
  • No runtime code, dependency, or security-sensitive behavior is introduced.
  • No unmitigated P0 or P1 findings.

Methodology

Severity: None. Impact: No methodology-bearing change; the diff only edits README presentation in README.md:L9-L13. Concrete fix: None.

Code Quality

Severity: None. Impact: The Markdown change is small and coherent; removing one badge and replacing another does not introduce structural issues in the rendered badge block at README.md:L9-L13. Concrete fix: None.

Performance

Severity: None. Impact: README-only change; no library runtime, build-path, or inference-performance effect. Concrete fix: None.

Maintainability

Severity: None. Impact: Removing the docs status badge does not orphan docs access because the README already provides explicit documentation links in README.md:L49-L56. Concrete fix: None.

Tech Debt

Severity: None. Impact: No new deferred work or TODO-worthy follow-up is introduced by this presentation-only change. Concrete fix: None.

Security

Severity: None. Impact: No secrets, code-execution surface, or sensitive-data handling changes are present; the new Pepy badge is just another external README asset/link. Concrete fix: None.

Documentation/Tests

Severity: P3-informational. Impact: This is a documentation-presentation change only, so test additions are not required; documentation access remains available via README.md:L49-L56. Concrete fix: None.

@igerber igerber added the ready-for-ci Triggers CI test workflows label Apr 26, 2026
@igerber igerber merged commit 6b928bc into main Apr 26, 2026
5 of 6 checks passed
@igerber igerber deleted the docs/readme-badge-cumulative-downloads branch April 26, 2026 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-ci Triggers CI test workflows

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant